<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>axis_switch: xaxis_switch.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">axis_switch
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xaxis__switch_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xaxis_switch.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_axis___switch___config.html">XAxis_Switch_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for the AXI4-Stream Switch core.  <a href="struct_x_axis___switch___config.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_axis___switch.html">XAxis_Switch</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The AXI4-Stream Switch driver instance data.  <a href="struct_x_axis___switch.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga19b5f68d74238e0c11856dbe5e566237"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axis__switch.html#ga19b5f68d74238e0c11856dbe5e566237">XAXIS_SWITCH_H_</a></td></tr>
<tr class="memdesc:ga19b5f68d74238e0c11856dbe5e566237"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent circular inclusions by using protection macros.  <a href="group__axis__switch.html#ga19b5f68d74238e0c11856dbe5e566237">More...</a><br/></td></tr>
<tr class="separator:ga19b5f68d74238e0c11856dbe5e566237"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa82658cbc43e600c53a429fce04d3a4c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axis__switch.html#gaa82658cbc43e600c53a429fce04d3a4c">XAxisScr_RegUpdateEnable</a>(InstancePtr)</td></tr>
<tr class="memdesc:gaa82658cbc43e600c53a429fce04d3a4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro enables register updates.  <a href="group__axis__switch.html#gaa82658cbc43e600c53a429fce04d3a4c">More...</a><br/></td></tr>
<tr class="separator:gaa82658cbc43e600c53a429fce04d3a4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafc168e986cd2b401045578c06bc90869"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axis__switch.html#gafc168e986cd2b401045578c06bc90869">XAxisScr_RegUpdateDisable</a>(InstancePtr)</td></tr>
<tr class="memdesc:gafc168e986cd2b401045578c06bc90869"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro disables register updates.  <a href="group__axis__switch.html#gafc168e986cd2b401045578c06bc90869">More...</a><br/></td></tr>
<tr class="separator:gafc168e986cd2b401045578c06bc90869"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa631f268bd77eca8acc9534775649df1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_axis___switch___config.html">XAxis_Switch_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axis__switch.html#gaa631f268bd77eca8acc9534775649df1">XAxisScr_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:gaa631f268bd77eca8acc9534775649df1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns a reference to an <a class="el" href="struct_x_axis___switch___config.html" title="This typedef contains configuration information for the AXI4-Stream Switch core. ">XAxis_Switch_Config</a> structure based on the core id, <em>DeviceId</em>.  <a href="group__axis__switch.html#gaa631f268bd77eca8acc9534775649df1">More...</a><br/></td></tr>
<tr class="separator:gaa631f268bd77eca8acc9534775649df1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga91d899fe6d8456f8460acd4a122dce64"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axis__switch.html#ga91d899fe6d8456f8460acd4a122dce64">XAxisScr_CfgInitialize</a> (<a class="el" href="struct_x_axis___switch.html">XAxis_Switch</a> *InstancePtr, <a class="el" href="struct_x_axis___switch___config.html">XAxis_Switch_Config</a> *CfgPtr, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:ga91d899fe6d8456f8460acd4a122dce64"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the AXI4-Stream Switch core.  <a href="group__axis__switch.html#ga91d899fe6d8456f8460acd4a122dce64">More...</a><br/></td></tr>
<tr class="separator:ga91d899fe6d8456f8460acd4a122dce64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga943a402b210b5f2901b6d6e7ae323d50"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axis__switch.html#ga943a402b210b5f2901b6d6e7ae323d50">XAxisScr_MiPortEnable</a> (<a class="el" href="struct_x_axis___switch.html">XAxis_Switch</a> *InstancePtr, u8 MiIndex, u8 SiIndex)</td></tr>
<tr class="memdesc:ga943a402b210b5f2901b6d6e7ae323d50"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables the MUX port specified by a MI index and links with desired SI, indicated by a SiIndex.  <a href="group__axis__switch.html#ga943a402b210b5f2901b6d6e7ae323d50">More...</a><br/></td></tr>
<tr class="separator:ga943a402b210b5f2901b6d6e7ae323d50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1fcba7107d4ecb9955aa302c1b798729"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axis__switch.html#ga1fcba7107d4ecb9955aa302c1b798729">XAxisScr_MiPortDisable</a> (<a class="el" href="struct_x_axis___switch.html">XAxis_Switch</a> *InstancePtr, u8 MiIndex)</td></tr>
<tr class="memdesc:ga1fcba7107d4ecb9955aa302c1b798729"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function disables the MUX port specified by a MI index and un-link SI, set previously.  <a href="group__axis__switch.html#ga1fcba7107d4ecb9955aa302c1b798729">More...</a><br/></td></tr>
<tr class="separator:ga1fcba7107d4ecb9955aa302c1b798729"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga35ef34ba6c57b57506741b4a04f87e75"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axis__switch.html#ga35ef34ba6c57b57506741b4a04f87e75">XAxisScr_IsMiPortEnabled</a> (<a class="el" href="struct_x_axis___switch.html">XAxis_Switch</a> *InstancePtr, u8 MiIndex, u8 SiIndex)</td></tr>
<tr class="memdesc:ga35ef34ba6c57b57506741b4a04f87e75"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the status of whether MUX is sourced from desired SI.  <a href="group__axis__switch.html#ga35ef34ba6c57b57506741b4a04f87e75">More...</a><br/></td></tr>
<tr class="separator:ga35ef34ba6c57b57506741b4a04f87e75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga993cbd838dd30de44a943c7f4a046101"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axis__switch.html#ga993cbd838dd30de44a943c7f4a046101">XAxisScr_IsMiPortDisabled</a> (<a class="el" href="struct_x_axis___switch.html">XAxis_Switch</a> *InstancePtr, u8 MiIndex)</td></tr>
<tr class="memdesc:ga993cbd838dd30de44a943c7f4a046101"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the status of whether MUX is disabled.  <a href="group__axis__switch.html#ga993cbd838dd30de44a943c7f4a046101">More...</a><br/></td></tr>
<tr class="separator:ga993cbd838dd30de44a943c7f4a046101"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga84a532ac4e377199c15802d84b43256e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axis__switch.html#ga84a532ac4e377199c15802d84b43256e">XAxisScr_MiPortDisableAll</a> (<a class="el" href="struct_x_axis___switch.html">XAxis_Switch</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga84a532ac4e377199c15802d84b43256e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function disables all the MUX port, in turn removes association with desired SI.  <a href="group__axis__switch.html#ga84a532ac4e377199c15802d84b43256e">More...</a><br/></td></tr>
<tr class="separator:ga84a532ac4e377199c15802d84b43256e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad9c646b6e8d7f5d6c431c2985592fb4b"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axis__switch.html#gad9c646b6e8d7f5d6c431c2985592fb4b">XAxisScr_SelfTest</a> (<a class="el" href="struct_x_axis___switch.html">XAxis_Switch</a> *InstancePtr)</td></tr>
<tr class="memdesc:gad9c646b6e8d7f5d6c431c2985592fb4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function performs self test on AXI4-Stream Switch core registers.  <a href="group__axis__switch.html#gad9c646b6e8d7f5d6c431c2985592fb4b">More...</a><br/></td></tr>
<tr class="separator:gad9c646b6e8d7f5d6c431c2985592fb4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
